home *** CD-ROM | disk | FTP | other *** search
/ Just Call Me Internet / Just Call Me Internet.iso / com / internet / stik / atarirc / atarirc.doc < prev    next >
Text File  |  1997-09-06  |  19KB  |  468 lines
  1. AtarIRC Documentation
  2. ---------------------
  3. Coded by Lonny L Pursell
  4. (C)1996-97 by Lonny L Pursell and ENCOM
  5. All rights reserved.
  6.  
  7. ** FreeWare **
  8.  
  9.  
  10. Disclaimer
  11. ----------
  12. Use entirely at your own risk!
  13.  
  14.  
  15. Support
  16. -------
  17. This program is FreeWare.  This program is fully functional and there
  18. are no disabled features or software keys required to use it.  You
  19. need not send me anything, however any donations will be accepted.
  20.  
  21. Contact:
  22.  
  23. Lonny Pursell
  24. 101 1/2 S High Street  Apt C
  25. Columbus Grove  OH  45830
  26. USA
  27.  
  28. E-Mail: atari@bright.net
  29.    WWW: http://www.bright.net/~atari/
  30.    IRC: lp @ #Atari
  31.  
  32. When reporting bugs please include the version number and a
  33. _detailed_ description of your system setup.
  34.  
  35. Note: I do not have the time or desire to blindly track what
  36. looks like bugs on non-Atari hardware.  If this program fails
  37. on an emulator I suggest you either don't use this program or
  38. get a real computer.
  39.  
  40. Since the introduction of STiK some other programs have been designed
  41. that emulate it or claim compatibility with STiK.  This software was
  42. coded for STiK.  If this software functions with STiK but fails on
  43. these others stacks then the problem has to be in the STiK emulation.
  44. Please contact the author of the STiK emulator instead.
  45.  
  46.  
  47. Credits
  48. -------
  49. I'd like to thank...
  50.   All the people who sent me e-mail regarding the program.
  51.  
  52.   Baldrick, evl, Flinny, GABBERKID, kellis, Matrixx, Q-Funk, and vitus
  53.   Sorry if I missed anyone!
  54.  
  55.  
  56. IRC Client Information
  57. ----------------------
  58. A channel on IRC is referenced with the '#' in front of it.  The
  59. Atari channel would be refered to as '#Atari' in all related IRC
  60. commands.  Note that #Atari is the same as #atari.
  61.  
  62. Anything entered into the IRC client starting with a '/' is
  63. interpreted as a command, otherwise it's echoed to the current
  64. channel for all to see.
  65.  
  66. All commands not listed below are sent to the server just as you typed
  67. them.  The IRC client doesn't interpret them at all so any error
  68. messages you see are server generated.  An example would be '/whois
  69. nick' which is a server command and thus not interpreted by the client
  70. at all.  Only commands interpreted by the client are listed below.
  71.  
  72.  
  73. Misc Info
  74. ---------
  75. Supports a maximum of 10 simultaneous sessions in any combination
  76. where a single session could be a channel, a query ,a DCC file
  77. operation, or a DCC chat.  If ran in a mode with more than 16 colors
  78. then only the first 16 colors are used.  Sound is supported but only
  79. on machines which are equiped with DMA sound capabilities.
  80.  
  81.  
  82. Command List
  83. ------------
  84. /AWAY
  85.   '/away' marks you as being away and displays the default message
  86.   '/away message' marks you as being away and displays 'message' 
  87.   when on a clock symbol appears in the window info line
  88.   only the current channel is notified that you are marked as away
  89. /BYE
  90.   same as /quit
  91. /BACK
  92.   '/back' turns away off and uses the default message
  93.   '/back message' turns away off and uses 'message'
  94.   only the current channel is notified when you return
  95. /BAN
  96.   '/ban' shows a list of bans for the current channel
  97.   '/ban mask' will set a ban for 'mask' on the current channel
  98. /CAB
  99.   '/cab http://www.url' tells CAB to load web page 'http://www.url'
  100.   '/cab' this will load your own page
  101.   note: CAB must running for this command to work
  102. /CAPTURE
  103.   '/capture' display capture file size in bytes
  104.   when on a 'c' in a circle appears in the window info line
  105.   all text shown in the scrolling area will be captured
  106.   when the limit is reached a bell sounds and capture is turned off
  107. /CD
  108.   '/cd' displays the current path
  109.   '/cd path' sets the 'path' on the current drive
  110.   '/cd \' sets the path to the root of the current drive
  111.   '/cd ..' backs up one folder on the current drive
  112. /CHDRIVE
  113.   '/chdrive' displays the current drives
  114.   '/chdrive d' set the current drive to 'd'
  115.   note: /d: will also change the drive where d = drive letter '/a:'
  116. /CLIENTINFO
  117.   '/clientinfo' request clientinfo from everyone in the current channel
  118.   '/clientinfo nick' sends a clientinfo request to 'nick'
  119.   '/clientinfo #channel' request clientinfo from everyone in '#channel'
  120.   '/clientinfo nick ?' fetches a list of supported parameters
  121.     parameters supported:
  122.       'cjar'   fetch cookie jar
  123.       'email'  fetch e-mail address
  124.       'ip'     fetch ip address
  125.       'module' fetch STiK version information
  126.       'name'   fetch real name
  127.       'ram'    fetch st ram and tt ram sizes in bytes
  128.       'server' fetch server name and port number
  129.       'tos'    fetch TOS version number
  130.       'video'  fetch video mode details
  131.       'www'    fetch www url
  132. /CONNECT
  133.   '/connect' attempt connection to default server and port
  134.   '/connect i' attempt connection to 'i' from the server list
  135.   '/conncet server' attempt connection to 'server' on default port
  136.   '/conncet server port' attempt connection to 'server' on 'port'
  137.   note: a valid /connect command can be passed as a parameter at start up
  138. /CWD
  139.   same as /cd
  140. /CTCP nick message
  141.   '/ctcp nick' defaults to '/ctcp nick version'
  142.   '/ctcp nick message' sends a ctcp 'message' to 'nick'
  143.   the 'message' will be converted to uppercase
  144.   ctcp returns 'errmsg' in reply to unsupported ctcp commands
  145. /DCC
  146.   '/dcc' same as '/dcc list'
  147.   '/dcc list' shows status of current dcc connections and channels
  148.   '/dcc get' accept current dcc window
  149.   '/dcc get nick' accept dcc from 'nick'
  150.   '/dcc close' closes current dcc connection window
  151.   '/dcc close nick' closes dcc connection to 'nick'
  152.   '/dcc chat nick' starts a private chat session with 'nick'
  153.   '/dcc send nick' send 'nick' a file via the file selector
  154.   '/dcc send nick file' send 'nick' a 'file'
  155.   if the remote end doesn't send the file size it displays '-1' instead
  156. /DEBUG
  157.   '/debug' shows connection data which is all in $hex
  158.   '/debug #' where '#' is a number from 0 to 255 for debug level (0=off)
  159.     currently only bits 1 and 2 are used
  160.   '/debug on' begins data logging (same as '/debug 1')
  161.   '/debug off' stops data logging (same as '/debug 0')
  162.   '/debug mem' show free memory status
  163.   '/degub misc' show some internal values
  164.   the log file will contain all data going in and out of the irc client
  165.   holding the alternate key when the program starts begins logging too
  166.   a check mark appears in the window info line when debug mode is on
  167. /DEFINE
  168.   '/define' displays the current contents of all ~variables
  169.   '/define string' is used to define the variable ~user only
  170.   example: '/define lp' would set variable ~user to 'lp'
  171. /DELETE
  172.   '/delete' calls file selector
  173.   '/delete file' deletes 'file' from disk
  174.   the file will be deleted when you press return with no warning
  175. /DEOP
  176.   '/deop nick' will take operator status away from 'nick' if you are an op
  177.   more than one nick can be listed seperated by spaces
  178. /DFREE
  179.   '/dfree' returns the free bytes on the current drive
  180.   '/dfree d' returns the free bytes on drive 'd'
  181. /DNS
  182.   '/dns hostname' resolves 'hostname' into an ip address
  183. /DIR
  184.   '/dir' lists all files in the current drive path '*.*'
  185.   '/dir mask' lists all files in the current drive path matching 'mask'
  186.   files show sizes and and folders show '<dir>' instead
  187.   press escape to abort the dir
  188. /DISCONNECT
  189.   '/disconnect' disconnects you from the server only (default quit message)
  190.   '/disconnect message' disconnects you from the server with 'message'
  191.   all dcc connections remain intact and active
  192. /ECHO
  193.   '/echo nick message' requests an echo from 'nick'
  194.   '/echo #channel message' requests an echo from everyone in '#channel'
  195. /EXIT
  196.   same as /quit
  197. /FIND
  198.   '/find data' will search the user list for 'data'
  199.   this command translates to '/who *data*'
  200. /FINGER
  201.   '/finger' fingers everyone in the current channel
  202.   '/finger nick' sends a finger request to 'nick'
  203.   '/finger #channel' sends a finger request to everyone in '#channel'
  204.   '/finger user@host' will finger 'user' at 'host'
  205. /IGNORE
  206.   '/ignore' displays current ignore list (a max of 5 can be set)
  207.   '/ignore host' add or remove 'host' to or from the ignore list
  208.   when ignore is on an 'X' appears in the window info line
  209.   note: 'host' can be a full host name or a partial host mask
  210.     example: someone logged on as: 'dork@ppp4-duh.netcom' you can use:
  211.       '/ignore dork@ppp4-duh.netcom' (full user@host name)
  212.       '/ignore ppp4-duh.netcom' (host name only)
  213.       '/ignore duh.netcom' (partial host name)
  214.       '/ignore .netcom' (this would ignore all netcom users!)
  215. /INVITE
  216.   '/invite nick' will invite 'nick' to the current channel
  217.   '/invite nick #channel' will invite 'nick' to '#channel'
  218. /J
  219.   same as /join
  220. /JOIN 
  221.   '/join' joins the default channel
  222.   '/join #channel' join IRC '#channel'
  223. /KICK
  224.   '/kick nick' remove 'nick' from current channel and display default message
  225.   '/kick nick message' remove 'nick' from current channel and display 'message'
  226. /KICKBAN
  227.   '/kickban nick' kicks and and bans 'nick' with a simple nick mask
  228.     default kick message is used
  229.   '/kickban nick mask' kicks and bans nick with specific 'mask'
  230.     default kick message is used
  231.   '/kickban nick mask message' kicks and bans 'nick' with 'mask'
  232.     'message' will be used instead of default kick message
  233. /L
  234.   same as /part
  235. /LS
  236.   same as /dir
  237. /LEAVE
  238.   same as /part
  239. /LOGOFF
  240.   same as /disconnect
  241. /LOGON
  242.   same as /connect
  243. /ME
  244.   '/me message' displays your nick followed by 'messege'
  245.   you can also use your nick as a command rather than /me if you like
  246.   example: '/me loves Atari' displays 'lp loves Atari'
  247.            '/lp loves Atari'
  248. /MKDIR
  249.   '/mkdir folder' creates folder 'folder' on the current drive
  250. /MSG nick message 
  251.   '/msg nick message'  sends 'nick' a private 'message'
  252.   example: '/msg lp Are we having fun yet?'
  253. /NICK nick
  254.   '/nick newnick' changes your nick to 'newnick'
  255.   a nick has a maximum of 9 characters
  256. /NOTIFY
  257.   '/notify' displays current notify list status (a max of 40 can be set)
  258.   '/notify nick' add or remove 'nick' to or from the notify list
  259.   note: setting your notify timer below 1 minute might cause flooding
  260.         when notify is on a '?' appears in the window info line
  261. /OP
  262.   '/op nick' will give 'nick' operator status if you are an op
  263.   more than one nick can be listed seperated by spaces
  264. /PART
  265.   '/part' leave current #channel
  266.   '/part #channel' leave a specific '#channel' 
  267. /P
  268.   same as /ping
  269. /PING
  270.   '/ping' ping everyone in the current channel
  271.   '/ping nick' ping 'nick' only
  272.   '/ping #channel' ping everyone in '#channel'
  273. /PRINT
  274.   '/print' calls file selector
  275.   '/print file.txt' sends file 'file.txt' to the line printer
  276.   press escape to abort the printing
  277. /QUERY
  278.   '/query nick' starts a query with 'nick'
  279.   '/query' closes a query
  280. /QUIT
  281.   'quit' leave IRC and display default message (closes the IRC session)
  282.   '/quit message' leave IRC and display 'message'
  283.   example: '/QUIT I'll be back...'
  284.   ends all dcc connections that might still be active
  285.   exits the program
  286. /RENAME
  287.   'rename file1 file2' renames 'file1' to 'file2'
  288.   the file will be renamed when you press return with no warning
  289. /RMDIR
  290.   '/rmdir folder' deletes folder 'folder' on the current drive
  291.   only empty folders can be deleted
  292. /SEARCH
  293.   '/search' same as doing '/list' so be prepared to for a long list
  294.   '/search string' does a '/list' but only displays matches to 'string'
  295. /SEND
  296.   '/send' calls file selector
  297.   '/send file.txt' sends 'file.txt' to the current window
  298.   the data is sent out the modem and eched to the screen too
  299.   press escape to abort the send
  300. /SERVER
  301.   same as /connect
  302. /SOUND
  303.   '/sound nick file' sends a sound command to 'nick' to play sound 'file'
  304.   '/sound #channel file' sends the sound command to the channel
  305.   '/sound nick' calls the file selector
  306.   '/sound nick ?' request a sound directory list from 'nick'
  307.   note: the file name is sent just as you typed it
  308. /TIME
  309.   '/time' returns the server time information
  310.   '/time nick' requests time information from 'nick'
  311.   '/time #channel' requests time information from eveyone in '#channel'
  312. /TOPIC
  313.   '/topic' displays the current channel topic
  314.   '/topic string' sets current channel topic to 'string'
  315. /UNBAN
  316.   '/unban mask' will remove the ban for 'mask' on the current channel
  317. /USERINFO
  318.   '/userinfo' request userinfo from everyone in the current channel
  319.   '/userinfo nick' sends a userinfo request to 'nick'
  320.   '/userinfo #channel' request userinfo from everyone in '#channel'
  321. /VERSION
  322.   '/version' returns the server version information
  323.   '/version nick' requests version information from 'nick'
  324.   '/version #channel' requests version information from eveyone in '#channel'
  325. /VIEW
  326.   '/view' calls file selector
  327.   '/view file' displays 'file' to the screen only
  328.   no data is sent out the modem
  329.   press escape to abort the view
  330. /W
  331.   same as /who
  332. /WHO
  333.   '/who' shows info about all users on the server
  334.   '/who *' shows info about all the members of the current channel
  335.   '/who lp' shows info only about 'lp' 
  336.   '/who *bright.net*' shows info on all users matching 'bright.net'
  337. /XSOUND
  338.   '/xsound nick file' sends a dcc file request to 'nick' for 'file'
  339.   '/xsound nick ?' request a sound directory list from 'nick'
  340.   note: the file name is sent just as you typed it
  341.         sounds can also be requested in the open channel with !<nick> <file>
  342.  
  343.  
  344. Dynamic Variables
  345. -----------------
  346. Variables can be used in the command line.
  347. The following commands support variables to:
  348.   /fkey strings
  349.   /away and /back messages
  350.   /quit messages
  351.   /userinfo reply
  352.   /finger reply
  353.   /kick message
  354.   /ping message
  355.     ~nick     your current nick
  356.     ~chan     current channel (same as prompt)
  357.     ~join     last nick that entered the current channel
  358.     ~part     last nick that left the current channel
  359.     ~ping     last nick that did a /ping on you
  360.     ~finger   last nick that did a /finger on you
  361.     ~version  last nick that did a /version on you
  362.     ~msg      last nick that sent you a private /msg or you did /msg too 
  363.     ~quit     last nick that quit irc from current channel
  364.     ~kick     last nick that was kicked from the current channel
  365.     ~ctcp     last nick that sent you a /ctcp message or you did /ctcp too
  366.     ~date     current date format: mm/dd/yyyy
  367.     ~time     current time format: hh:mm:ss (24 hour clock)
  368.     ~ctime    connect time format: 00h00m00s
  369.     ~invite   last nick that sent you an invite message
  370.     ~user     user definable string
  371.     ~rnick    generates a random 9 character string to be used as a nick
  372.     ~cnick    last nick changed on any channel you might be in
  373.     ~title    irc client title
  374.     ~email    your e-mail address
  375.     ~www      your world wide web address
  376.     ~rname    your real name
  377.     ~uname    your user name
  378.     ~hname    your host name
  379.     ~ip       client ip address
  380.     ~|        return (only one per fkey and must be on the end if used)
  381.     ~-        outputs a single tilde character '~'
  382.   example: /fkey 1 my nick is ~nick and i am in channel ~chan~|
  383.     pressing f1 would display: 'my nick is lp and i am in channel #atari' 
  384.  
  385.  
  386. Misc Keys 
  387. ---------
  388. ALTERNATE      pause screen
  389.   this might help with viewing the channel /list
  390.   holding the alternate key down too long may cause data overflow?
  391. BACKSPACE      delete character to the left of the cursor
  392. CLR\HOME       clear the command line
  393. CONTROL A      opens the credit window
  394. CONTROL B      toggle bold text on and off
  395. CONTROL C      toggle light/colored text on and off
  396. CONTROL D      toggle auto dcc get on off (files only)
  397.   when on an '*' appears in the window info line
  398. CONTROL F      toggle flood control on and off
  399.   when on the tilde char '~' appears in the window info line
  400. CONTROL G      ring the console bell (at both ends)
  401. CONTROL I      toggle /ignore on and off
  402.   when on an 'X' appears in the window info line
  403. CONTROL K      tcp kick current window (really only good for dcc send)
  404. CONTROL L      toggle capture/logging on and off
  405.   when on a 'c' in a cirlce appears in the window info line
  406. CONTROL M      toggle incoming /msg bell on and off
  407.   when on a bell symbol appears in the window info line
  408. CONTROL N      toggle /notify on or off
  409.   when on a '?' question mark appears in the window info line
  410. CONTROL O      shuts all effects off (background redraws only)
  411. CONTROL P      ping server
  412. CONTROL R      toggle dcc resume on or off
  413. CONTROL S      toggle /sound support on and off
  414.   when on an musical note appears in the window info line
  415. CONTROL U      restore default colors (black text on a white background)
  416. CONTROL V      toggle reverse text on and off
  417. CONTROL X      removes the current nick from the TAB key buffer
  418. CONTROL -      toggle underline text on and off
  419. DELETE         delete character at cursor position
  420. DOWN ARROW     move cursor down
  421. F1-F10         function key macro
  422. HELP           setup/configuration
  423. INSERT         last command recall
  424. LEFT ARROW     move cursor left
  425. RETURN         execute command line
  426. RIGHT ARROW    move cursor right
  427. SHIFT CLR\HOME clear screen
  428. SHIFT F1-F10   function key macro
  429. SHIFT INSERT   paste from clipboard
  430. TAB            auto /msg reply, this types '/msg nick' for you
  431. UNDO           terminate/close the current dcc connection window
  432. UP ARROW       move cursor up
  433. (              change window down one (keypad)
  434. )              change window up one (keypad)
  435. -              scroll command line history down (keypad)
  436. +              scroll command line history up (keypad)
  437.  
  438. SHIFT-LEFT ARROW   move cursor to the far left of current line
  439. SHIFT-RIGHT ARROW  move cursor to the far right of current line
  440. SHIFT-UP ARROW     move cursor to the top line
  441. SHIFT-DOWN ARROW   move cursor to the bottom line
  442.  
  443.  
  444. Mouse Functions
  445. ---------------
  446. BUTTON BAR     selects one of the buttons in the bar
  447. COMMAND LINE   moves the cursor to the character clicked on
  448. TEXT AREA      left mouse button will cut
  449.                  shift will append to clipboard
  450.                right mouse button will paste
  451.                alternate will cut/paste to the command line
  452.                control will cut/paste url to CAB
  453.  
  454.  
  455. Known Problems
  456. --------------
  457. For some reason certain key combinations are interpreted as
  458. though function key F13 was pressed when it was not.
  459. To work around this minor bug do not define F13 as anything.
  460.  
  461. During a DCC file transfer the files remain open so if you happen
  462. to do something that causes a media change on the same drive it
  463. might cause the file to be closed and thus shorter than it should
  464. be when complete.
  465. Try not to do to many file operations while doing a DCC file transfer.
  466.  
  467. eof
  468.